/*
 * $Id: Dirs.java 23 2002-09-29 13:59:30Z bpruessmann $
 * 
 * Copyright (c) 2001 Boris Pruessmann and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Common Public License v0.5
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v05.html
 * 
 * Contributors:
 *    Boris Pruessmann - Initial implementation.
 */
package net.sourceforge.p4eclipse.internal.core.api;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import net.sourceforge.p4eclipse.core.api.ClientUser;
import net.sourceforge.p4eclipse.core.api.IPerforceCommand;
import net.sourceforge.p4eclipse.core.syncinfo.FolderSyncInfo;
import net.sourceforge.p4eclipse.ui.PerforceUIPlugin;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;

/**
  * ClientUser object for the 'p4 dirs' command.
  * 
  * @version 	$Revision: 23 $
  * @author		<a href="mailto:bpruessmann@users.sourceforge.net">Boris Pruessmann</a>
  */
public class Dirs extends ClientUser implements IPerforceCommand
{
	private List result = new ArrayList();	
	private IStatus status;
	
	/**
	  * Convenience method for creating instances of Dirs.
	  */
	public static final Dirs newInstance()
	{
		MultiStatus status = new MultiStatus(PerforceUIPlugin.ID, IStatus.OK, "", null); //$NON-NLS-1$
		return new Dirs(status);
	}
	
	/**
	  * Creates a new instance.
	  */
	private Dirs(MultiStatus status)
	{		
		super(status);
		this.status = status;
	}
	
	/**
	  * @see IClientUser#outputStat(Map)
	  */
	public void outputStat(Map strDict)
	{
		FolderSyncInfo syncInfo = new FolderSyncInfo();
		syncInfo.setDepotFileName((String)strDict.get("dir")); //$NON-NLS-1$
			
		result.add(syncInfo);						
	}
	
	/**
	  * Returns the name of the p4 command of this instance.
	  */
	public String getCommand()
	{
		return "dirs"; //$NON-NLS-1$
	}
	
	/**
	  * Returns the result of the operation.
	  */
	public FolderSyncInfo[] getResult()
	{
		return (FolderSyncInfo[])result.toArray(new FolderSyncInfo[result.size()]);
	}
	
	/**
	  * Returns the IStatus object associated with the Dirs instance.
	  */
	public IStatus getStatus()
	{
		return status;
	}
	
	/** @see IPerforceCommand#isHidingFromConsole() */
	public boolean isHidingFromConsole()
	{
		return false;
	}	
}
